-
Notifications
You must be signed in to change notification settings - Fork 38
Documentation update #291
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation update #291
Conversation
build/lib/skglm/__init__.py
Outdated
| @@ -0,0 +1,6 @@ | |||
| __version__ = '0.4dev' | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@floriankozikowski those files should not be committed, delete build/lib and and it to .gitignore
.DS_Store
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
delete this file and ignore it
doc/.DS_Store
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
…into documentation-update
…iew image once online! (otherwise need to change to png instead of svg
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mega job @floriankozikowski 💪
I love the new look of the doc! So excited to see the finished version
| "version_dropdown": True, | ||
| "switcher": { | ||
| # NOTE: must be a URL and not a path relative to doc | ||
| "json_url": "https://raw.githubusercontent.com/floriankozikowski/skglm/refs/heads/documentation-update/doc/_static/switcher.json", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the json_url must be a URL not a path in doc folder
c.f. https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/version-dropdown.html#configure-switcher-json-url
once we merge this PR, we will change it,
this one is a work-around to check that the switcher renders/works as expected
…sibility, fix tab title
…crease speed though
|
Congratulations on the job @floriankozikowski |
Context of the PR
Contributions of the PR
new theme (more similar to other scikit websites)
Custom theme colors introduced via style.css and conf.py
• Attempt to fully override all default purple values in Bootstrap, PyData Sphinx Theme, and Sphinx Design System
• Updated inline code styling to reflect brand colors
• Reviewed all :root CSS tokens and added scoped --pst-color-primary variables
Checks before merging PR